AllocationScreen

Element/Tag

Definition

Attribute

Element/Attribute Value and Description

<AllocationScreen>

The opening and closing tag of the AllocationScreen business rule.

    <Allocations>

Required element;
Indicates the Allocation level. The AllocationScreen business rule is used to configure the Policy Allocation screen.

TYPE

Optional attribute;

="Policy/Plan"

To indicate the level of allocation.
 

Plan:  Defines if Allocation configuration is at the plan level.

Policy:  Defines if Allocation configuration is at the policy level.

AMOUNTPRECISION

Optional attribute;

="Constant"

To specify the maximum number of digits allowed after the decimal point.  Used when allocating money.

There is no restriction on the maximum or minimum value in the code.  If this attribute is not used, the default value, "2" will be used.

PERCENTPRECISION

Optional attribute;

="Constant"

To specify the maximum number of digits allowed after the decimal point.  Used when allocations are percentages.

There is no restriction on the maximum or minimum value in the code.  If this attribute is not used, the default value, "2" will be used.

USEEFFECTIVEDATE

Optional attribute;

Used to display different effective dates for a model and allows you to select a group of allocations by model and effective date.  

Yes:  Allows for effective dates.

No:  Indicates effective dates aren’t used.

       <Allocation>

Required/RepeatableElement;

The Allocation tag is a required sub element that indicates we are configuring a specific allocation.

The Allocation tag has specific attributes that help define the allocation further.

TYPECODE

Required attribute;

="AllocationTypeCode"

Is the Allocation Code number that is defined in AsCodeAllocationType.

FUNDLIMIT

Optional Attribute;

="Integer"*

To set the limit on the number of funds that can be made available for allocation.

EXCLUDEFUNDSTATUS

Optional Attribute;

="FundStatus"*

To prevent the funds (that are in the specified fund status) from being available for allocation.

For example:

EXCLUDEFUNDSTATUS="01,03" - Indicates that the funds that are in these statuses should not be available for allocation. 01 & 03 may indicate active and closed fund status, respectively.

EXCLUDETYPE

Optional attribute;

="FundTypeCode"

List of Fund Types(comma separated codes) that should be excluded from the Allocation Fund drop down list.

       <AllocationMethods>

Required element;

Lists the Allocation Methods that are applicable for this allocation type.

Required element value;

="AllocationMethodCode"

Defines AllocationMethodCode (percent, amount, units, etc.)

       <AllocationTransfer>

Optional Element;
Presence of element creates a fund transfer (ie.To/From Fund selection for the particular allocation type).

REPEATFUNDS

Optional attribute;
="Yes"
If Yes, allows user to select the same fund in the From and To sections for a transfer type transaction.

             <AllocationFrom>

Required Element;
This element is used to identify the list of funds that should be available for transfer.

FUNDLIMIT

Optional Attribute;
="Integer"*
To set the limitation on the number of funds that can be made available for allocation.

METHODCODES

Optional attribute;
="AllocationMethodCode"
Defines AllocationMethodCode (percent, amount, units, etc.).
 

ALLOWMIXEDMETHODS

Optional attribute;

="Constant"

Validation to determine if the Fund amount is at least equal to the specified minimum amount.

<DisableAllocationFields>

Optional Element;

This element is used to disable the fields of certain allocation types in the Allocation screen based on the policy status.

    <DisabledPolicyStatus>

Required Element:
This element is used to specify the list of policy status codes for the fields in the Allocation screen that should be disabled.

Required/Repeated element value;
PolicyStatusCode
Comma separated policy status code from AsCodeStatus table.